Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The customer unique identifier in your system

Query Parameters

score_streak_id
string<uuid>

Filter results to a single score streak by its UUID

campaign_id
string<uuid>

Filter results to streaks belonging to a specific campaign

status
enum<string>
default:ACTIVE

Filter streaks by status. Defaults to ACTIVE

Available options:
ALL,
ACTIVE,
CLOSED
include
enum<string>

Pass history to include flattened, time-ordered history events in the response

Available options:
history
limit
integer
default:100

Maximum number of history events to return when include=history. Defaults to 100, max 200

Required range: 1 <= x <= 200

Response

Ok

Default response (no include param)

data
object[]